━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ Sleipnir API リファレンス Copyright (C) 2002-2004 by Yasuyuki Kashgiwagi. Copyright (C) 2005 by Fenrir & Co. All Rights Reserved. ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ Sleipnir のスクリプトは Windows Scripting Host (WSH) を利用して動作します。 \scripts\ 以下のスクリプトを読み込みます。 $ で始まる名前のフォルダ以下のスクリプトは読み込みません。 作業用のスクリプトやアウトプット用のイベントスクリプトを保存するのにご利用くだ さい。 スクリプトを使用するには「Sleipnir オプション｜スクリプトによるクライアントの 操作を許可する」のチェックを有効にしてください。このオプションはデフォルトでは 無効になっています。 一部、Sleipnir 1.66 と異なる部分があります。アップデートで強化していきます。 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ■ プロパティ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ (R) … 読み取り専用です。値の設定はできません。 [string] AddressBarString アドレスバーの文字列を取得/設定する。 [string] SearchBarString 検索バーの文字列を取得/設定する。 [string] URL アクティブなドキュメントの URL を取得/設定する。 [long] ActiveIndex アクティブなドキュメントのタブ位置を取得/設定する。 [string] FavoriteFile お気に入りファイルを取得/設定する。 [string] AppPath(R) Sleipnir.exe の存在するディレクトリを返す。 [string] ScriptPath(R) スクリプトの読み込まれるディレクトリを返す。 [string] ResourcePath(R) リソースの読み込まれるディレクトリ返す。 [string] UserPath(R) 各種設定の保存するディレクトリを返す。 [string] UserAgent UserAgent を取得/設定する。 [long] Handle(R) Sleipnir のウィンドウハンドルを返す。 [long] Result Sleipni API の結果を返す。 [long] Version(R) Sleipnir のバージョンを返す。 // 1.30 以降 [bool] ShiftDown(R) Shift キーの状態を返す。 [bool] CtrlDown(R) Ctrl キーの状態を返す。 [bool] AltDown(R) Alt キーの状態を返す。 [bool] OutputVisible アウトプットバーの可視状態を取得/設定する。 [long] OutputCurSel アウトプットバーの選択行を取得/設定する。 [string] OutputScript アウトプットでダブルクリックされた時に呼ばれるスクリ プトファイルを取得/設定する。このスクリプトは引数とし て /output:選択行 が渡される。 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ■ メソッド ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ──────── [long] GetCount ──────── [説明] 　開かれているドキュメントの数を返す。 [引数] 　なし [戻り値] 　開かれているドキュメントの数 ──────────────── [long] GetDocumentID(long index) ──────────────── [説明] 　ドキュメント固有の ID を取得する。 [引数] 　index: タブ位置( 0 〜 GetCount-1 ) [戻り値] 　ドキュメント固有の ID ────────────────── [IDispatch] GetWindowObject(long id) ────────────────── [説明] 　Window Object を取得する。 [引数] 　id: ドキュメント固有の ID [戻り値] 　Windows Object の IDispatch ─────────────────── [IDispatch] GetDocumentObject(long id) ─────────────────── [説明] 　HTML Document Object を取得する。 [引数] 　id: ドキュメント固有の ID [戻り値] 　Document Object の IDispatch ──────────────────── [IDispatch] GetWebBrowserObject(long id) ──────────────────── [説明] 　WebBrowser Object を取得する。 [引数] 　id: ドキュメント固有の ID [戻り値] 　WebBrowser Object の IDispatch ─────────────────────── [long] NewWindow(string strUrl, bool bActive) ─────────────────────── [説明] 　新しくドキュメントを開く。 [引数] 　strUrl: 新しく開くドキュメントの Url 　bActive: 新しく開くウィンドウをアクティブにするか [戻り値] 　開かれたドキュメント固有の ID ─────────── [void] Close(long id) ─────────── [説明] 　指定のドキュメントを閉じる。 [引数] 　id: ドキュメント固有の ID [戻り値] 　なし ──────────────────── [void] Navigate(long id, string strUrl) ──────────────────── [説明] 　現在のドキュメントで任意の URL にアクセスする。 [引数] 　id: ドキュメント固有の ID 　strUrl: ナビゲートする Url [戻り値] 　なし ──────────── [long] GetIndex(long id) ──────────── [説明] 　ドキュメント固有の ID からタブ位置を取得する。 [引数] 　id: ドキュメント固有の ID [戻り値] 　タブ位置 ────────────────── [void] MessageBox(string strMessage) ────────────────── [説明] 　Sleipnir のメッセージボックスを表示する。 [引数] 　strMessgae: 表示するメッセージ [戻り値] 　なし ───────── [void] Beep(void) ───────── [説明] 　Beep 音を鳴らす。 [戻り値] 　なし ─────────── [BOOL] IsBusy(long id) ─────────── [説明] 　ドキュメントが読み込み中か判断する。 [引数] 　id: ドキュメント固有の ID [戻り値] 　読み込み中の場合は true ────────────────────────────────────── [void] SetSecurity(long id, BOOL bJavaScript, BOOL bJava, BOOL bRunActiveX, BOOL bDownloadActiveX, BOOL bPicture, BOOL bSound, BOOL bVideo) ────────────────────────────────────── [説明] 　ドキュメントのセキュリティを設定する。 [引数] 　id: ドキュメント固有の ID 　各値: 各セキュリティ ──────────────────── [BOOL] IsJavaScriptEnabled(long id) [BOOL] IsJavaEnabled(long id) [BOOL] IsRunActiveXEnabled(long id) [BOOL] IsDownloadActiveXEnabled(long id) [BOOL] IsPictureEnabled(long id) [BOOL] IsSoundEnabled(long id) [BOOL] IsVideoEnabled(long id) ──────────────────── [説明] 　ドキュメントのセキュリティを取得する。 [引数] 　id: ドキュメント固有の ID [戻り値] 　有効ならば true ─────────────── [BOOL] IsNavigateLock(long id) ─────────────── [説明] 　ナビゲートロックが有効か取得する。 [引数] 　id: ドキュメント固有の ID [戻り値] 　有効ならば true ─────────────────────── [void] SetNavigateLock(long id, BOOL bEnable) ─────────────────────── [説明] 　ナビゲートロックを有効・無効にする。 [引数] 　id: ドキュメント固有の ID 　bEnable: 有効にするなら true [戻り値] 　なし ──────────────────── [BOOL] SaveFavorite(string strFileName) ──────────────────── ●Sleipnir 2.00 では対応していません。 [説明] 　お気に入りを保存する。 [引数] 　strFileName: 保存するファイル名（フルパスで指定） [戻り値] 　成功なら true ─────────── [void] SaveClosedURL() ─────────── ●Sleipnir 2.00 では対応していません。 [説明] 　最近閉じたページをファイルに上書き保存する。 [引数] 　なし [戻り値] 　なし ───────────────────── [BOOL] Search(long id, string strKeyword) ───────────────────── ●Sleipnir 2.00 では対応していません。 [説明] 　ページ内検索を実行する。 [引数] 　strKeyword: キーワード [戻り値] 　キーワードが発見できない、または先頭のキーワードに戻ってきたら false ───────────────────── [void] Hilight(long id, string strKeyword) ───────────────────── ●Sleipnir 2.00 では対応していません。 [説明] 　ハイライトを実行する。 [引数] 　strKeyword: キーワード [戻り値] 　なし ────────────────────────────────── [void] WriteProfileInt(string strSection, string strKey, long nData) ────────────────────────────────── [説明] 　\script.ini に long 型データを書き込む。 [引数] 　strSection: セクション 　strKey: キー 　nData: データ [戻り値] 　なし ────────────────────────────────────── [void] WriteProfileString(string strSection, string strKey, string strData) ────────────────────────────────────── [説明] 　\script.ini に string 型データを書き込む。 [引数] 　strSection: セクション 　strKey: キー 　strData: データ [戻り値] 　なし ─────────────────────────────────── [long] GetProfileInt(string strSection, string strKey, long nDefault) ─────────────────────────────────── [説明] 　\script.ini から long 型データを読み込む。 [引数] 　strSection: セクション 　strKey: キー 　nDefault: キーが存在しないときに返される値 [戻り値] 　データ ─────────────────────────────────────── [string] GetProfileString(string strSection, string strKey, string strDefault) ─────────────────────────────────────── [説明] 　\script.ini から string 型データを読み込む。 [引数] 　strSection: セクション 　strKey: キー 　strDefault: キーが存在しないときに返される値 [戻り値] 　データ ───────────────────────────────────── [void] WriteProfileIntCipher(string strSection, string strKey, long nData) ───────────────────────────────────── [説明] 　\script.ini に long 型データを暗号化して書き込む。 [引数] 　strSection: セクション 　strKey: キー 　nData: データ [戻り値] 　なし ───────────────────────────────── [void] WriteProfileStringCipher(string strSection, string strKey, string strData) ───────────────────────────────── [説明] 　\script.ini に string 型データを暗号化して書き込む。 [引数] 　strSection: セクション 　strKey: キー 　strData: データ [戻り値] 　なし ────────────────────────────────────── [long] GetProfileIntCipher(string strSection, string strKey, long nDefault) ────────────────────────────────────── [説明] 　\script.ini から暗号化された long 型データを読み込む。 [引数] 　strSection: セクション 　strKey: キー 　nDefault: キーが存在しないときに返される値 [戻り値] 　データ ───────────────────────────────── [string] GetProfileStringCipher(string strSection, string strKey, string strDefault) ───────────────────────────────── [説明] 　\script.ini から暗号化された string 型データを読み込む。 [引数] 　strSection: セクション 　strKey: キー 　strDefault: キーが存在しないときに返される値 [戻り値] 　データ ─────────── [BOOL] IsRead(long id) ─────────── ●Sleipnir 2.00 では対応していません。 [説明] 　ドキュメントが既読か判断する。 [引数] 　id: ドキュメント固有の ID [戻り値] 　既読の場合は true ─────────────────────────── [string] InputBox(string strPrompt, string strDefault) ─────────────────────────── [説明] 　文字列を入力するダイアログを表示する。 [引数] 　strPrompt: プロンプト 　strDefault: デフォルトの文字列 [戻り値] 　OK の場合は編集された文字列、Cancel の場合は strDefault 　※Result プロパティに 1（OK）、0（Cancel）が設定される。 ───────────────────── [void] SetAutoRefresh(long id, long nTime) ───────────────────── [説明] 　自動更新の時間を設定する。 [引数] 　id: ドキュメント固有の ID 　nTime: 更新時間（0 〜 1000 秒） [戻り値] 　なし ─────────────── [long] GetAutoRefresh(long id) ─────────────── [説明] 　自動更新の時間を取得する。 [引数] 　id: ドキュメント固有の ID [戻り値] 　自動更新の時間（単位 = 秒） ──────────── [long] OutputGetCount() ──────────── [説明] 　アウトプットに出力されている文字列の行数を取得する。 [引数] 　なし [戻り値] 　行数 ───────────────── [void] OutputAddString(string str) ───────────────── [説明] 　アウトプットに文字列を追加する。 [引数] 　str: 出力する文字列 [戻り値] 　なし ─────────────────────── [void] OutputInsertString(long n, string str) ─────────────────────── [説明] 　アウトプットに文字列を挿入する。 [引数] 　n: 挿入する位置 　str: 出力する文字列 [戻り値] 　なし ────────── [void] OutputClear() ────────── [説明] 　アウトプットをクリアする。 [引数] 　なし [戻り値] 　なし ──────────────── [string] OutputGetString(long n) ──────────────── [説明] 　アウトプットから文字列を取得する。 [引数] 　n: 取得する行 [戻り値] 　文字列 ───────────────── [void] OutputDeleteString(long n) ───────────────── [説明] 　アウトプットから文字列を削除する。 [引数] 　n: 削除する行 [戻り値] 　なし ───────────────────────────── string MaskedInputBox(string strPrompt, string strDefault) ───────────────────────────── [説明] 　マスクで保護された文字列を入力するダイアログを表示する。 [引数] 　strPrompt: プロンプト 　strDefault: デフォルトの文字列 [戻り値] 　OK の場合は編集された文字列、Cancel の場合は strDefault 　※Result プロパティに 1（OK）、0（Cancel）が設定される。 ──────────────────────────────────── [long] GetProfileIntEx(string strSection, string strKey, long nDefault, string strFileName) ──────────────────────────────────── [説明] 　strFileName で指定される INI ファイルから long 型データを読み込む。 [引数] 　strSection: セクション 　strKey: キー 　nDefault: キーが存在しないときに返される値 　strFileName: 設定を読み込むファイル [戻り値] 　データ ───────────────────────────────── [string] GetProfileStringEx(string strSection, string strKey, string strDefault, string strFileName) ───────────────────────────────── [説明] 　strFileName で指定される INI ファイルから string 型データを読み込む。一部のフ 　ァイルでは "" で囲まれた文字列が返されることがあります。 [引数] 　strSection: セクション 　strKey: キー 　strDefault: キーが存在しないときに返される値 　strFileName: 設定を読み込むファイル [戻り値] 　データ ───────────────────────────── [void] DeleteProfileKey(string strSection, string strKey) ───────────────────────────── [説明] 　\script.ini から任意のキーを削除する。 [引数] 　strSection: セクション 　strKey: キー [戻り値] 　なし ────────────────────────────── [long] MsgBox(string strPrompt, string strTitle, long lFlag) ────────────────────────────── [説明] 　WinAPI::MessageBox を呼び出す。 [引数] 　strPrompt: メッセージボックスに表示する文字列 　strTitle: メッセージボックスのタイトル 　lFlag: WinAPI::MessageBox の値と同じ [戻り値] 　WinAPI::MessageBox の戻り値と同じ ──────────── [void] ReloadClosedURL() ──────────── ●Sleipnir 2.00 では対応していません。 [説明] 　ClosedURL.ini を再度読み込む。 [引数] 　なし [戻り値] 　なし ─────────────────── [void] AddSearchBarHistory(string ss) ─────────────────── ●Sleipnir 2.00 では対応していません。 [説明] 　検索バーの履歴に項目を追加する。文字列がすでに存在する場合は先頭に移動されます。 [引数] 　ss: 追加する文字列 [戻り値] 　なし ─────────────── [void] ExecCommand(long cmdID) ─────────────── ●Sleipnir 2.00 では対応していません。 [説明] 　Sleipnir の任意のメニューを cmdID で指定して実行します。cmdID はマウスジェス 　チャー(Gesture.ini)等から参照してください。 [引数] 　cmdID: コマンドID [戻り値] 　なし ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━